home *** CD-ROM | disk | FTP | other *** search
/ Chip 2005 June / ccd0605.iso / Software / Freeware / Programare / highlight / highlight-W32GUI-2.2-10b-Setup.exe / {app} / README_ES.txt < prev    next >
Text File  |  2005-02-10  |  12KB  |  363 lines
  1. --------------------------------------------------------------------------------
  2. ---  MANUAL DE HIGHLIGHT - Versi≤n 2.2-8 -------------------------- FEB 2004 ---
  3. --------------------------------------------------------------------------------
  4.  
  5. OSI Certified Open Source Software
  6.  
  7. Deutsche Anleitung: README_DE
  8.  
  9. --------------------------------------------------------------------------------
  10.  
  11. Highlight convierte c≤digo fuente a archivos HTML, XHTML, RTF, LaTeX,
  12. TeX, XSL-FO o XML con resalte de sintaxis.  Las definiciones de lenguajes,
  13. temas de color e indentaci≤n son configurables.
  14.  
  15.  
  16. CONTENIDO:
  17.  
  18. 1.  Plataformas
  19. 2.  Lenguajes de programaci≤n/marcado contemplados
  20. 3.  Caracterφsticas
  21. 4.  Formato del fichero Highlight
  22. 5.  Definici≤n de nuevos lenguajes
  23. 6.  Definici≤n de nuevos temas de color
  24. 7.  Definici≤n de nuevos esquemas de indentaci≤n
  25. 8.  Informaci≤n de contacto
  26.  
  27.  
  28. 1. PLATAFORMAS
  29. --------------------------------------------------------------------------------
  30.  
  31. Highlight estß escrito en ISO C++. Existen tres versiones:
  32. - aplicaci≤n UNIX para consola
  33. - aplicaci≤n W32 para consola
  34. - aplicaci≤n W32 grßfica
  35.  
  36. El paquete fuente compila con gcc3.x, MS Visual .NET y MW Codewarrior 8.
  37.  
  38.  
  39. 2. LENGUAJES DE PROGRAMACI╙N / MARCADO CONTEMPLADOS:
  40.  
  41. Actualmente, highlight contempla los siguientes lenguajes de
  42. programaci≤n, marcado y ficheros de configuraci≤n:
  43.  
  44. Action Script, ADA 95, Agda, AMPL, Aspect, Assembler, Amtrix, Avenue, (G)AWK,
  45. Bash, BlitzBasic, BibTex, BMS, C, C++, C#, ClearBasic, Clipper, Cobol, Coldfusion
  46. MX, CSS, DOS-Batch, Eiffel, Erlang, Euphoria, Express, Felix, Fortran, Frink,
  47. Haskell, HTML, httpd.conf, Icon, IDL, INI, IO, Jasmin, Java, JavaScript, JSP,
  48. LaTeX, LDIF, Lisp, Lotos, Lotus Script, Lua, Make,Maya, Matlab, Maple, Modelica,
  49. Modula 3, Nasal, OCaml, (Object) Pascal, Objective C, Paradox, PATROL, Perl,
  50. PHP, Pike, PL/1, PL/SQL, PostScript, POV Ray, Progress, Prolog, Python, Relax
  51. NG Compact, Rexx, RPM Spec, Ruby, Small, SML, SNMPv2, Spin, Squirrel, Sybase, 
  52. VHDL, Visual Basic, XML.
  53.  
  54.  
  55. 3. CARACTER═STICAS:
  56. --------------------------------------------------------------------------------
  57.  
  58. - resaltado de palabras clave, tipos, cadenas, n·meros, secuencias de escape, 
  59.   comentarios, sφmbolos y directivas.
  60. - resaltado de conjuntos de palabras clave configurables.
  61. - salida coloreada en formato HTML, XHTML 1.1, RTF, TeX, LaTeX, XSL-FO o XML
  62. - reformateo e indentaci≤n configurable de c≤digo fuente  C, C++, C# y Java
  63. - divisi≤n de lineas largas
  64. - n·meros de lφnea
  65. - elecci≤n entre empotrar las definiciones CSS en el fichero (X)HTML o guardarlas 
  66.   como un fichero CSS aparte
  67. - 50 temas de color
  68. - conversi≤n de texto plano al formato elegido sin resalte de sintaxis.
  69.  
  70.  
  71. 4. FORMATO DEL FICHERO HIGHLIGHT
  72. --------------------------------------------------------------------------------
  73.  
  74. Todos los ficheros de configuraci≤n de highlight se guardan en ficheros de texto.
  75. El formato es simple:
  76.  
  77. $ParamName=ParamValue
  78.  
  79. ParamName es el identificador del parßmetro, ParamValue es su valor.
  80. Los nombres de parßmetros no distinguen entre may·scula y min·scula.
  81. El valor puede ser un carßcter simple o una lista de palabras. Las listas se
  82. pueden separar en m·ltiples lφneas.
  83.  
  84. Las lφneas que comienzan con # en la primera columna son comentarios
  85.  
  86. 5. DEFINICI╙N DE NUEVOS LENGUAJES:
  87. --------------------------------------------------------------------------------
  88.  
  89. Una definici≤n de lenguajes es un fichero de texto, en el que las palabras clave
  90. y los sφmbolos del lenguaje de programaci≤n pertenecen a diferentes categorφas.
  91. Se debe guardar el fichero en directorio highlight/langDefs* con el siguiente
  92. nombre:
  93.  
  94. <extensi≤n propia de los fichero del lenguaje>.lang
  95.  
  96. Ejemplos: PHP -> php.lang, Java -> java.lang
  97.  
  98. Si existen m·ltiples sufijos, p≤ngalos en extensions.conf*.
  99.  
  100. FORMATO DEL FICHERO:
  101.  
  102. # Lista de palabras reservadas; <class> es el nombre de la clase de palabras
  103. # reservadas
  104. # La clase debe estar definida en el tema de color aplicado para que el estilo
  105. # de resalte coincida
  106. $KW_LIST(<class>)=<List>
  107.  
  108. # Prefijo que determina palabras clave
  109. # La clase debe estar definida en el tema de color aplicado para que el estilo
  110. # de resalte coincida
  111. $KW_PREFIX(<class>)=<Character>
  112.  
  113. # Delimitadores para palabras clave
  114. # La clase debe estar definida en el tema de color aplicado para que el estilo
  115. # de resalte coincida
  116. $KW_DELIM(<class>)=<open close>
  117.  
  118. # Delimitadores para marcas de apertura y cierre
  119. # Las marcas se formatean como palabras clave de la clase especificada
  120. $TAG_DELIM(<class>)=<tag_open tag_close>
  121.  
  122. # Lista de delimitadores de cadena
  123. $STRINGDELIMITERS=<List>
  124.  
  125.  
  126. # Par de delimitadores de cadena diferentes
  127. # Ejemplo: s" " en Forth
  128. $STRINGDELIMITERPAIR=<open close>
  129.  
  130. # Lista de caracteres de escape en cadenas (ie. "\")
  131. $ESCCHAR=<List>
  132.  
  133. # Prefijo que desactiva el resalte de caracteres de escape
  134. # para la siguiente cadena
  135. $RAWSTRINGPREFIX=<Character>
  136.  
  137. # Delimitadores de comentarios multi-lφnea
  138. $ML_COMMENT=<comment_begin comment_close>
  139.  
  140. # Lista de cadenas que comienzan comentarios de una lφnea
  141. $SL_COMMENT=<List>
  142.  
  143. # Fijado a 'true' si los comentarios de una lφnea tienen que empezar en la
  144. # primera columna
  145. $FL_COMMENT=<true / false>
  146.  
  147. # Cadena de comienzo de las directivas del preprocesador
  148. $DIRECTIVE=<prefix>
  149.  
  150. # Fijado a 'true' si el c≤digo fuente del lenguaje se puede reformatear
  151. # (s≤lo lenguajes tipo C!)
  152. $REFORMATTING=<true / false>
  153.  
  154. # Sφmbolos que se pueden colorear (llaves, operadores,  etc)
  155. $SYMBOLS=<List>
  156.  
  157. # Lista de caracteres especiales que pueden aparecen en palabras reservadas
  158. $ALLOWEDCHARS=<character list>
  159.  
  160.  
  161. # Fijado a 'true' si los comentarios multi-lφnea se pueden anidar
  162. $ALLOWNESTEDCOMMENTS=false
  163.  
  164. # Fijado a 'true' si el lenguaje de programaci≤n no distingue entre may·sculas
  165. # y min·sculas
  166. $IGNORECASE=<true / false>
  167.  
  168. # Incluye otra definici≤n de lenguaje almacenada en el mismo directorio
  169. $INCLUDE=<language definition>
  170.  
  171.  
  172.  
  173. Ejemplo:
  174.  
  175. #Contenido de pas.lang (Pascal/Object Pascal)
  176.  
  177. $KW_LIST(kwa)=true false if else then nil maxint case goto label and div downto in
  178. mod not of or packed with do for do repeat while to until procedure function
  179. program begin end const var type unit interface implementation uses private
  180. public
  181.  
  182. $KW_LIST(kwb)=array boolean char integer file pointer real set string text record
  183.  
  184. $STRINGDELIMITERS=" '
  185. $SL_COMMENT=//
  186. $ML_COMMENT={ }
  187. $IGNORECASE=true
  188.  
  189. CONSEJO: Si no quieres guardar definiciones de lenguajes nuevas en el directorio de
  190.          instalaci≤n por defecto, debes indicar a highlight otra ruta
  191.          donde buscar con la opci≤n --add-data-dir.
  192.  
  193.  
  194. 6. DEFINICI╙N DE NUEVOS TEMAS DE COLOR
  195. --------------------------------------------------------------------------------
  196.  
  197. Los temas de color se guardan en ficheros ASCII, en los que se define el for-
  198. mato de salida. La salida RTF ignora el atributo de color de fondo. Los fiche-
  199. ros deben estar en el directorio themes* y deben tener extensi≤n *.style.
  200.  
  201. FORMATO DEL FICHERO:
  202.  
  203. #<ColourAttr> = RR GG BB
  204. #RR GG BB describe los valores rojo/verde/azul en hexadecimal que definen el color.
  205. #(Rango: 00 (nada) - FF (todo))
  206.  
  207. #<FormatAttr> = <bold> <italic> <underline>
  208. #Negrita, cursiva y subrayado son atributos opcionales que se pueden combinar
  209.  
  210. # Color del texto no reconocido
  211. $DEFAULTCOLOUR=RR GG BB
  212.  
  213. # Color de fondo (ignorado por RTF)
  214. $BGCOLOUR=RR GG BB
  215.  
  216. # Tama±o de letra
  217. $FONTSIZE=<number>
  218.  
  219. # Formato de palabras reservadas, que pertenece a la clase correspondiente
  220. $KW_CLASS(<class>)=<ColourAttr> ( <FormatAttr> )
  221.  
  222. # Formato de los n·meros
  223. $NUMBER=<ColourAttr> ( <FormatAttr> )
  224.  
  225. # Formato de los caracteres de escape
  226. $ESCAPECHAR=<ColourAttr> ( <FormatAttr> )
  227.  
  228. # Formato de las cadenas
  229. $STRING=<ColourAttr> ( <FormatAttr> )
  230.  
  231. # Formato de las cadenas con directivas del compilador
  232. $STRING_DIRECTIVE=<ColourAttr> ( <FormatAttr> )
  233.  
  234. # Formato de los comentarios
  235. $COMMENT=<ColourAttr> ( <FormatAttr> )
  236.  
  237. # Formato de los comentario de una lφnea
  238. $SL-COMMENT=<ColourAttr> ( <FormatAttr> )
  239.  
  240. # Formato de las directivas del compilador
  241. $DIRECTIVE=<ColourAttr> ( <FormatAttr> )
  242.  
  243. # Formato de sφmbolos (opcional, igual a $DEFAULTCOLOUR si se omite)
  244. $SYMBOL=<ColourAttr> ( <FormatAttr> )
  245.  
  246. # Formato de los n·meros de lφnea
  247. $LINE=<ColourAttr> ( <FormatAttr> )
  248.  
  249.  
  250. Ejemplo:
  251.  
  252. # Golden.style
  253. $DEFAULTCOLOUR=dd bb 00
  254. $BGCOLOUR=00 00 00
  255. $FONTSIZE=10
  256. $KW_CLASS(kwa)=dd bb 00 bold
  257. $KW_CLASS(kwb)=dd bb 00
  258. $NUMBER=ff ff ff
  259. $ESCAPECHAR=ff 00 00
  260. $STRING=ff 00 00
  261. $STRING_DIRECTIVE=ff 00 00
  262. $COMMENT=97 83 45 italic
  263. $DIRECTIVE=ff dd aa
  264. $LINE=97 83 45
  265.  
  266.  
  267. 7.  DEFINICI╙N DE NUEVOS ESQUEMAS DE INDENTACI╙N
  268. --------------------------------------------------------------------------------
  269.  
  270. Se pueden definir esquemas de indentaci≤n y formateo a medida. Para habilitar el
  271. reformateo de un lenguaje de programaci≤n, la opci≤n $REFORMATTING=true debe
  272. a±adirse a la definici≤n del lenguaje. Note que el reconocedor 'Artistic Style'
  273. se dise±≤ s≤lo para manejar lenguajes tipo C (C++, Java, C#).
  274. Los esquemas de indentaci≤n se guardan en el directorio indentSchemes* y deben
  275. tener extensi≤n *.indent. 
  276.  
  277. FORMATO DEL FICHERO:
  278.  
  279. # manejo de llaves:
  280. # "break":  Separar llaves del bloque precedente (i.e. ANSI C/C++ style).
  281. # "attach": Dejar las llaves junto al bloque precedente (i.e. Java/K&R style).
  282. # "linux":  Separar llaves en los bloques de definici≤n y dejarlas en los bloques de ≤rdenes.
  283. # "break-closing-headers": Separar llaves antes de las cabeceras de cierre (e.g. 'else',
  284. #                          'catch', ..).  Se deberφa a±adir a $brackets=attach o $brackets=linux.
  285. $BRACKETS=<break | attach | linux | break-closing-headers>
  286.  
  287. # Inserta lφneas vacφas entre bloques no relacionados, etiquetas, clases, ...
  288. # "true": modo por defecto
  289. # "all":  tambiΘn inserta lφneas vacφas entorno a las cabeceras de cierre
  290. #        (e.g. 'else', 'catch', ...).
  291. $BREAK-BLOCKS=<true | false | all>
  292.  
  293. # Divide las sentencias 'else if()' en dos lφneas diferentes.
  294. $BREAK-ELSEIFS=<true / false>
  295.  
  296. # A±ade indentaci≤n extra para bloques (incluyendo las llaves).
  297. $INDENT-BLOCKS=<true / false>
  298.  
  299. # A±ade indentaci≤n extra a las llaves.
  300. $INDENT-BRACKETS=<true / false>
  301.  
  302. # Indenta las lφneas 'case XXX:', de modo que se alineen con sus bloques de c≤digo.
  303. $INDENT-CASES=<true / false>
  304.  
  305. # Indenta los bloques 'class' 'class' blocks, asφ como su 'public:', 'protected:'
  306. and 'private:'
  307. # Las cabeceras se indentan en relaci≤n a bloque de la clase.
  308. $INDENT-CLASSES=<true / false>
  309.  
  310. # Indenta etiquetas de modo que aparecen en un nivel de indentaci≤n menos que el actual,
  311. # en lugar de completamente a la izquierda (que es el comportamiento por defecto).
  312. $INDENT-LABELS=<true / false>
  313.  
  314. # Indenta el contenido de los bloques 'namespace'.
  315. $INDENT-NAMESPACES=<true / false>
  316.  
  317. # Indenta las sentencias #define  multi-lφnea
  318. $INDENT-PREPROCESSOR=<true / false>
  319.  
  320. # Indenta usando <num> espacios por indentaci≤n. Si no se especifica <num> se
  321. # aplica el valor por defecto, que son 4 espacios por indentaci≤n.
  322. $INDENT-SPACES=<num>
  323.  
  324. # Indenta los bloques 'switch', de modo que sus 'case XXX:' se indentan en relaci≤n
  325. # al bloque switch block.
  326. $INDENT-SWITCHES=<true / false>
  327.  
  328. # Indenta un fichero fuente Java
  329. $JAVA-STYLE=<true / false>
  330.  
  331. # Indenta un mßximo de <num> espacios en una sentencia continua, de forma relativa
  332. # a la lφnea previa
  333. $MAX-INSTATEMENT-INDENT=<num>
  334.  
  335. # Indenta un mφnimo de <num> espacios en sentencias condicionales continuas.
  336. $MIN-CONDITIONAL-INDENT=<num>
  337.  
  338. # Separar sφmbolos con espacios en blanco:
  339. # "paren": Inserta espacios s≤lo alrededor de los parΘntesis
  340. # "oper":  Inserta espacios s≤lo alrededor de los operadores
  341. # "all":   Inserta espacios alrededor de parΘntesis Y operadores
  342. $PAD=<paren | oper | all>
  343.  
  344.  
  345. Ejemplo:
  346.  
  347. # K&R indentation scheme
  348. $indent-brackets=false
  349. $indent-spaces=4
  350. $brackets=attach
  351. $indent-classes=false
  352. $indent-switches=false
  353. $indent-namespaces=false
  354.  
  355.  
  356. 8. INFORMACI╙N DE CONTACTO
  357. --------------------------------------------------------------------------------
  358.  
  359. Andre Simon
  360. andre.simon1@gmx.de
  361. http://www.andre-simon.de/
  362.  
  363.